Skip to main content

Using PDF/A with the RESTful Engine

The RESTful Report Engine supports PDF/A (Archive) compliance. PDF/A is a subset of the PDF specification that ensures PDF documents will look the same no matter where they are opened.

PDF/A compliance is not enabled by default in the RESTful Report Engine. Generating PDF/A compliant documents requires additional processing, which can slow down the report generation process.

There are multiple ways to enable PDF/A compliance in the RESTful Report Engine:

  1. You may add pdf.PDF_A=true to the WindwardReports.properties file. Then all PDF output from the RESTful Reporting engine will be PDF/A-3b compliant.
  2. You may also enable PDF/A on a per report basis at run time. In order to do this include the setting in the properties section of your POST request. For example:
{
    "OutputFormat": "pdf",
    "Properties": [
        {
            "Name": "pdf.PDF_A",
            "Value": "true"
        }
    ],
    "Data": "base64-encoded-template-data",
    "Format": "docx",
    "Datasources": [
        {
            "Name": "JSON",
            "Type": "json",
            "Data": "base64-encoded-json-data"
        }
    ]
}